Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add API docs for fast-components #3321

Merged
merged 7 commits into from
Jun 16, 2020
Merged

chore: add API docs for fast-components #3321

merged 7 commits into from
Jun 16, 2020

Conversation

nicholasrice
Copy link
Contributor

@nicholasrice nicholasrice commented Jun 16, 2020 •
edited
Loading

Description

Updates API docs for @microsoft/fast-components. Implements docs process into CI, which will fail if api-report.md is stale.

Motivation & context

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Adding or modifying component(s) in @microsoft/fast-components checklist

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

EisenbergEffect
EisenbergEffect approved these changes Jun 16, 2020
View reviewed changes
Copy link
Contributor

@EisenbergEffect EisenbergEffect left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Admittedly not looking at every single doc comment, but generally looks good.

@EisenbergEffect EisenbergEffect mentioned this pull request Jun 16, 2020
Closed
35 tasks
@nicholasrice nicholasrice merged commit 3fb5043 into master Jun 16, 2020
@nicholasrice nicholasrice deleted the users/nirice/document-fast-components branch June 16, 2020 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@janechu janechu janechu approved these changes

@EisenbergEffect EisenbergEffect EisenbergEffect approved these changes

@awentzel awentzel Awaiting requested review from awentzel awentzel is a code owner

@chrisdholt chrisdholt Awaiting requested review from chrisdholt chrisdholt is a code owner

@Falkicon Falkicon Awaiting requested review from Falkicon Falkicon is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nicholasrice @EisenbergEffect @janechu